Skip to content

Improve returned() documentation #966

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jul 3, 2025
Merged

Improve returned() documentation #966

merged 3 commits into from
Jul 3, 2025

Conversation

penelopeysm
Copy link
Member

@penelopeysm penelopeysm commented Jul 3, 2025 •
edited
Loading

The specific method returned(::Model, ::MCMCChains.Chains) wasn't documented, even though this is probably the primary usage of returned. This fixes it.

Bumped patch so that the stable version of the online docs can be updated (otherwise it'll only live in the dev docs).

@penelopeysm penelopeysm requested a review from mhauru July 3, 2025 14:56
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 3, 2025 •
edited
Loading

Benchmark Report for Commit 60c9fc6

Computer Information

Julia Version 1.11.5
Commit 760b2e5b739 (2025-04-14 06:53 UTC)
Build Info:
  Official https://julialang.org/ release
Platform Info:
  OS: Linux (x86_64-linux-gnu)
  CPU: 4 × AMD EPYC 7763 64-Core Processor
  WORD_SIZE: 64
  LLVM: libLLVM-16.0.6 (ORCJIT, znver3)
Threads: 1 default, 0 interactive, 1 GC (on 4 virtual cores)

Benchmark Results

|                 Model | Dimension |  AD Backend |      VarInfo Type | Linked | Eval Time / Ref Time | AD Time / Eval Time |
|-----------------------|-----------|-------------|-------------------|--------|----------------------|---------------------|
| Simple assume observe |         1 | forwarddiff |             typed |  false |                  9.4 |                 1.6 |
|           Smorgasbord |       201 | forwarddiff |             typed |  false |                615.8 |                43.9 |
|           Smorgasbord |       201 | forwarddiff | simple_namedtuple |   true |                298.4 |                70.6 |
|           Smorgasbord |       201 | forwarddiff |           untyped |   true |               1223.3 |                28.8 |
|           Smorgasbord |       201 | forwarddiff |       simple_dict |   true |               3606.9 |                22.2 |
|           Smorgasbord |       201 | reversediff |             typed |   true |               1433.0 |                29.6 |
|           Smorgasbord |       201 |    mooncake |             typed |   true |                940.1 |                 5.2 |
|    Loop univariate 1k |      1000 |    mooncake |             typed |   true |               5476.3 |                 4.1 |
|       Multivariate 1k |      1000 |    mooncake |             typed |   true |               1024.6 |                 8.8 |
|   Loop univariate 10k |     10000 |    mooncake |             typed |   true |              61384.8 |                 3.7 |
|      Multivariate 10k |     10000 |    mooncake |             typed |   true |               8812.1 |                 9.7 |
|               Dynamic |        10 |    mooncake |             typed |   true |                129.9 |                13.0 |
|              Submodel |         1 |    mooncake |             typed |   true |                 13.2 |                 6.6 |
|                   LDA |        12 | reversediff |             typed |   true |                454.2 |                 5.7 |

@codecov Codecov
Copy link

codecov bot commented Jul 3, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.98%. Comparing base (968c879) to head (60c9fc6).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #966   +/-   ##
=======================================
  Coverage   82.98%   82.98%           
=======================================
  Files          36       36           
  Lines        3961     3961           
=======================================
  Hits         3287     3287           
  Misses        674      674

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coveralls
Copy link

coveralls commented Jul 3, 2025 •
edited
Loading

Pull Request Test Coverage Report for Build 16053798986

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.08%) to 83.076%
Totals Coverage Status
Change from base Build 15755194770: -0.08%
Covered Lines: 3284
Relevant Lines: 3953
💛 - Coveralls

@coveralls
Copy link

coveralls commented Jul 3, 2025 •
edited
Loading

Pull Request Test Coverage Report for Build 16055151905

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 83.152%
Totals Coverage Status
Change from base Build 15755194770: 0.0%
Covered Lines: 3287
Relevant Lines: 3953
💛 - Coveralls

penelopeysm
penelopeysm commented Jul 3, 2025
View reviewed changes
@penelopeysm penelopeysm enabled auto-merge July 3, 2025 15:57
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 3, 2025

DynamicPPL.jl documentation for PR #966 is available at:
https://TuringLang.github.io/DynamicPPL.jl/previews/PR966/

@penelopeysm penelopeysm added this pull request to the merge queue Jul 3, 2025
Merged via the queue into main with commit 92f6eea Jul 3, 2025
22 checks passed
@penelopeysm penelopeysm deleted the py/returned-docs branch July 3, 2025 16:51
@mhauru mhauru mentioned this pull request Jul 7, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mhauru mhauru mhauru approved these changes

Assignees

@penelopeysm penelopeysm

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@penelopeysm @coveralls @mhauru